Module-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
struct fish_dto
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val NO_FISH_FOUND_MSG: text = "No fish found"

Functions

Link copied to clipboard
function _get_recently_caught_item(account_id: byte_array): (timestamp: integer, name: text, bait: text, rod: text)?
Link copied to clipboard
function _is_shoal(x: integer, y: integer, timestamp: integer, shoal_tile_probability: integer): boolean
Link copied to clipboard
function _register_fish(name: text, region: text, watertype: text, bait: text, tier: integer, durability_cost: integer)
Link copied to clipboard
function catch_item(player: player, hooked_item: hooked_item, timestamp: integer)
Link copied to clipboard
function catch_with_time(plot_id: integer, location: location, bait: text, rod_name: text, timestamp: integer, account_id: byte_array, auth_descriptor_id: byte_array)
Link copied to clipboard
function check_fishing_rate(player: player, in_shoal: boolean, timestamp: integer)
Link copied to clipboard
function choose_fish_for_shoal(x: integer, y: integer, timestamp: integer, eligible_fishes: list<fish_list_item_dto>): fish_list_item_dto
Link copied to clipboard
function choose_hooked_item(player: player, plot: instance, global_x: integer, global_y: integer, in_shoal: boolean, bait_name: text, rod_name: text, timestamp: integer): hooked_item
Link copied to clipboard
function choose_index_for_shoal(raw_x: integer, raw_y: integer, timestamp: integer): integer
Link copied to clipboard
function consume_bait(account_id: byte_array, bait_name: text)
Link copied to clipboard
function consume_rod_durability(player: player, rod: text, hooked_item: hooked_item)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
function hook_item(player: player, plot_id: integer, location: location, bait: text, rod: text, timestamp: integer): hooked_item
Link copied to clipboard
function hook_trash(bait: text, rod: text): hooked_item
Link copied to clipboard
function is_shoal(x: integer, y: integer, timestamp: integer): boolean
Link copied to clipboard
function noise_number(x: integer, y: integer, raw_timestamp: integer): integer
Link copied to clipboard
function random_fish_in_shoal(region: text, watertype: text, location: location): (text, tier: integer)?
Link copied to clipboard
function random_fish_in_zone_and_water(region: text, watertype: text, highest_tier: integer, bait: text): text?
Link copied to clipboard
function require_valid_probability(probability: integer)
Link copied to clipboard
function shoal_applies(bait: text, rod: integer, fish_in_shoal: fish_list_item_dto, random_num: integer): boolean
Link copied to clipboard
function shoal_candidates(region: text, watertype: text): list<fish_list_item_dto>

Queries

Link copied to clipboard
@mount("fishing.get_all_fish_prototypes") query get_all_fish_prototypes(): list<fish_info_dto>
Link copied to clipboard
@mount("fishing.get_all_registered_fishes") query get_all_registered_fishes(): list<(name: text, enabled: boolean)>
Link copied to clipboard
@mount("fishing.get_all_registered_fishes_with_details") query get_all_registered_fishes_with_details(): list<fish_dto>
Link copied to clipboard
@mount("fishing.get_all_trash_prototypes") query get_all_trash_prototypes(): list<(name: text, durability_cost: integer)>
Link copied to clipboard
@mount("fishing.get_fish_master_list") query get_fish_master_list(plot_id: integer): list<fish_list_item_dto>
Link copied to clipboard
@mount("fishing.get_fisherman_stickerbook_entries") query get_fisherman_stickerbook_entries(account_id: byte_array): list<text>
Link copied to clipboard
@mount("fishing.get_fishing_cards_for_plot") query get_fishing_cards_for_plot(plot_id: integer): list<(username: text,)>
Link copied to clipboard
@mount("fishing.get_fishing_configs") query get_fishing_configs(): (enabled: boolean, shoal_tile_probability: integer, fish_probability: integer, shoal_fish_probability: integer, fishing_rate: integer, shoal_fishing_rate: integer)
Link copied to clipboard
@mount("fishing.get_recently_caught_item") query get_recently_caught_item(account_id: byte_array): (timestamp: integer, name: text, bait: text, rod: text)?
Link copied to clipboard
@mount("fishing.get_shoal_tile_probability") query get_shoal_tile_probability(): integer

Operations

Link copied to clipboard
@mount("fishing.batch_register_fish") operation batch_register_fish(dto: batch_fish_dto)
Link copied to clipboard
@mount("fishing.batch_update_fish") operation batch_update_fish(dto: batch_update_fish_dto)
Link copied to clipboard
@mount("fishing.catch") operation catch(plot_id: integer, location: location, bait: text, rod: text, account_id: byte_array, auth_descriptor_id: byte_array)
Link copied to clipboard
@mount("fishing.give_fishing_card") operation give_fishing_card(plot_id: integer, receiver: text, account_id: byte_array, auth_descriptor_id: byte_array)
Link copied to clipboard
@mount("fishing.register_bait") operation register_bait(name: text, price: integer)
Link copied to clipboard
@mount("fishing.register_fish") operation register_fish(name: text, region: text, watertype: text, bait: text, tier: integer, durability_cost: integer)
Link copied to clipboard
@mount("fishing.register_trash") operation register_trash(name: text, durability_cost: integer)
Link copied to clipboard
@mount("fishing.revoke_fishing_card") operation revoke_fishing_card(plot_id: integer, card_holder: text, account_id: byte_array, auth_descriptor_id: byte_array)
Link copied to clipboard
@mount("fishing.set_fish_availability") operation set_fish_availability(fishes: list<(fish_name: text, enabled: boolean)>)
Link copied to clipboard
@mount("fishing.set_fish_probability") operation set_fish_probability(probability: integer)
Link copied to clipboard
@mount("fishing.set_global_fishing_parameters") operation set_global_fishing_parameters(enabled: boolean, shoal_tile_probability: integer, fish_probability: integer, shoal_fish_probability: integer, fishing_rate: integer, shoal_fishing_rate: integer)
Link copied to clipboard
@mount("fishing.set_shoal_fish_probability") operation set_shoal_fish_probability(probability: integer)
Link copied to clipboard
@mount("fishing.set_shoal_tile_probability") operation set_shoal_tile_probability(probability: integer)